billing-ux

(0 reviews)

TMF 635 GET - Usage

This operation lists or retrieves usage records, including usage characteristics and rated product usage information.

URL

https://[localhost]:[port]/billing-ux/v1/{businessId}/usage

URL Params

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	Y

Headers

name	type	description	required
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y

Query Param

name	type	description	required
usageCharacteristic[0].name	string	Name of the usage characteristic : bancan	Y*
usageCharacteristic[0].value	string	Value of the usage characteristic : 123445	Y*
usageCharacteristic[1].name	string	Name of the usage characteristic : MSISDN	Y*
usageCharacteristic[1].value	string	Value of the usage characteristic : 89178	Y*
usageCharacteristic[2].name	string	Name of the usage characteristic : invoiceNumber	Y*
usageCharacteristic[2].value	string	Value of the usage characteristic : 57821	Y*
usageCharacteristic[3].name	string	Name of the usage characteristic : paymentType	Y*
usageCharacteristic[3].value	string	Value of the usage characteristic : postpaid/prepaid	Y*
usageDate.gte	string	Usage details after this date : 2026-09-10T14:32:07:000Z	N*
usageDate.lte	string	Usage details before this date : 2026-09-10T14:32:07:000Z	N*
usageType	string	Usage type of event value : Voice	N
limit	integer	The number of items to return per page : 1	N*
offset	integer	The number of items to skip before starting to collect the result set: 10	N*

[GET] Retrieve Usage Details By UsageType Response

[
  {
    "date": "2026-09-10T14:32:07Z",
    "type": "voice",
    "description": "Postpaid billed usage record",
    "usageCharacteristic": [
      {
        "name": "msisdn",
        "value": "9876543210",
        "valueType": "string"
      },
      {
        "name": "bancan",
        "value": "BAN-4455667788",
        "valueType": "string"
      },
      {
        "name": "direction",
        "value": "outgoing",
        "valueType": "string"
      },
      {
        "name": "duration",
        "value": 185,
        "valueType": "integer"
      },
      {
        "name": "code",
        "value": "OUT_OF_PLAN",
        "valueType": "string"
      },
      {
        "name": "roamingOriginLocation",
        "value": "Puerto Rico",
        "valueType": "string"
      },
      {
        "name": "unit",
        "value": "SECONDS",
        "valueType": "string"
      },
      {
        "name": "destinationLocation",
        "value": "Dominican Republic",
        "valueType": "string"
      },
      {
        "name": "destinationNumber",
        "value": "18095551234",
        "valueType": "string"
      },
      {
        "name": "volumeUsed",
        "value": 185,
        "valueType": "integer"
      }
    ],
    "ratedProductUsage": [
      {
        "taxIncludedRatingAmount": 0.35,
        "@type": "RatedProductUsage"
      }
    ],
    "@type": "Usage"
  }
]

Response Data Model:

Each of the response parameters is detailed.

name	type	description	required
date	string	Date and time when the usage event occurred : 2026-09-10T14:32:07Z	N
type	string	Usage type such as voice, data, or sms : voice	N
description	string	Description of the usage event : Postpaid billed usage record	N
usageCharacteristic.name	string	Name of the characteristic : bancan	N
usageCharacteristic.value	string	The value of the characteristic : 123445	N
usageCharacteristic.valueType	string	The type value of the characteristic : string	N
ratedProductUsage.taxIncludedRatingAmount	string	Rated product usage information of Tax included rating amount : 0.35	N
ratedProductUsage.@type	array	Usage type such as voice, data, or sms : RatedProductUsage	N
@type	string	Type of the usage resource : Usage	N

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource."
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The server could not find the requested resource.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method POST not allowed for : /{businessId}/usage"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "Internal Server Error",
      "description": "The request failed due to an internal error."
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation GET /usage for Business Id: PR not implemented"
    }]
  }

Reviews